Feature/improve instrumentation #179
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
PR Overview
This PR enhances instrumentation and observability across the core modules by integrating OpenTelemetry for tracing, metrics, and logs, while also updating tests and logger implementations. Key changes include:
- Adding and testing a new OtelTracerProvider for custom span handling.
- Updating the logger repository to output JSON stringified log entries.
- Expanding container and Next.js configuration to support additional OpenTelemetry instrumentation.
Reviewed Changes
| File | Description |
|---|---|
| src/core/infrastructure/observability/otel-tracer-provider.{ts,test.ts} | Introduces a new tracer provider and its tests for span creation and termination. |
| src/core/infrastructure/utils/http-fetch-utils.{ts,test.ts} | Injects the tracer provider and uses it to manage spans during HTTP fetch calls. |
| src/core/infrastructure/observability/instrumentation-config.ts | Updates instrumentation configuration to include OpenTelemetry exporters/ instrumentations. |
| src/core/application/logger/logger-aggregator.ts | Augments log events with additional context details in log messages. |
| src/core/infrastructure/logger/pino-logger-repository.ts | Adjusts logger repository to log stringified JSON instead of raw objects. |
| src/core/infrastructure/container-registry/{observability/otel-module.ts, container-registry.ts} | Registers the OtelTracerProvider in dependency injection containers. |
| next.config.mjs | Expands Next.js configuration to support a broader set of instrumentation packages. |
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
src/core/application/logger/logger-aggregator.ts:118
- [nitpick] Consider renaming 'LogEventDetails' to 'logEventDetails' to follow camelCase naming conventions consistently.
const LogEventDetails = {
| @@ -60,26 +60,26 @@ export class PinoLoggerRepository implements LoggerRepository { | |||
|
|
|||
| info(message: string, context: LogContext, metadata?: LogMetadata): void { | |||
| const logEntry = this.createLogEntry('INFO', message, metadata, context) | |||
| this.logger.info(logEntry) | |||
| this.logger.info(JSON.stringify(logEntry)) | |||
There was a problem hiding this comment.
Using JSON.stringify for logging structured objects may hinder downstream processing that expects structured data. It is recommended to pass the log object directly.
Suggested change
| this.logger.info(JSON.stringify(logEntry)) | |
| this.logger.info(logEntry) |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
caioaletroca
approved these changes
Mar 5, 2025
tpmpb
approved these changes
Mar 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Midaz Console Pull Request Checklist
Pull Request Type
Checklist
Please check each item after it's completed.
Additional Notes
Obs: Please, always remember to target your PR to develop branch instead of main.